C#のソースファイル中に、型(クラス、インタフェースなど)および型のメンバ(メソッド、プロパティなど)に関する説明をXML形式で付与することができる。
これらはオブジェクトをマウスオーバーした際に付与された説明を表示(Visual Studio IntelliSenseの機能)したり、
コンパイル時にXMLドキュメントを出力することができる(後述)。
| タグ名 |
書式 |
適用先 |
説明 |
備考 |
| 型 |
メソッド |
プロパティ |
| summary |
/// <summary>型または型メンバの概要</summary> |
◯ |
◯ |
◯ |
型または型メンバの概要を記述する。 |
|
| remarks |
/// <remarks>補足説明</remarks> |
◯ |
◯ |
◯ |
summaryの内容を補足する。 |
|
| returns |
/// <returns>メソッド戻り値の説明</returns> |
|
◯ |
|
メソッドの戻り値に関する説明を記述する。 |
|
| param |
/// <param name="param1">パラメータ param1 の説明</param>
/// <param name="param2">パラメータ param2 の説明</param> |
|
◯ |
|
メソッドのパラメータ(引数)に関する説明を記述する。 |
name はメソッド宣言の仮引数と一致している必要がある。 |
| paramref |
/// <remarks><paramref name="param1"/> を使用する際は…</remarks> |
|
◯ |
|
summary や remarks など他のタグ中で
メソッドのパラメータを参照する。 |
当該パラメータの param の記述がある場合は、
そちらへの参照が作成される。 |
| typeparam |
/// <typeparam name="T1">型パラメータ T1 の説明</typeparam>
/// <typeparam name="T2">型パラメータ T2 の説明</typeparam> |
◯ |
◯ |
|
ジェネリック型、またはメソッドの
型パラメータに関する説明を記述する。 |
|
| typeparamref |
/// <remarks><typeparamref name="T1"/> を使用する際は…</remarks> |
◯ |
◯ |
|
summary や remarks など他のタグ中で
型パラメータを参照する。 |
当該型パラメータの typeparam の記述がある場合は、
そちらへの参照が作成される。 |
| exception |
/// <exception cref="ArgumentException">引数が不正</exception>
/// <exception cref="Exception">上記以外</exception> |
|
◯ |
◯ |
送出される例外を記述する。 |
cref は現在のコンパイル環境から使用できる例外を記述する。 |
| value |
/// <value>プロパティ値の説明</value> |
|
|
◯ |
プロパティが表す値を記述する。 |
|
| タグ名 |
書式 |
表示例
(IntelliSense)
|
説明 |
備考 |
| para |
<summary>
概要
</summary>
<remarks>
<para>
段落：序文
<para>
</para>
段落：本文
</para>
</remarks>
|
 |
段落を表現する。
段落の上下にはスペースが挿入される。
|
|
| br/ |
<summary>
概要
</summary>
<remarks>
1行目<br/>
2行目<br/>
3行目
</remarks>
|
 |
改行を挿入する。 |
|
| list |
|
|
リストを作成する。(後述) |
|
| code |
<summary>
概要
</summary>
<remarks>
<code>
var index = 5;
++index;
</code>
</remarks>
|
 |
複数行をコードとして指定する。
(ブロック)
|
整形済みテキストとして取り扱われる。
(HTMLの pre と同様。改行、スペースが記述通りに反映される。)
para 同様、上下にスペースが挿入される。
|
| c |
<summary>
概要
</summary>
<remarks>
行内に
<c>string</c>
を含む文
</remarks>
|
 |
行内の一部をコードとして指定する。
(インライン) |
|
| b |
<summary>
概要
</summary>
<remarks>
<b>BOLD/b><br/>
<i>ITALIC</i><br/>
<u>UNDERLINED</u>
</remarks>
|
 |
テキストを太字にする。 |
|
| i |
テキストを斜体にする。 |
|
| u |
テキストに下線を引く。 |
|
list タグは箇条書き(bullet)、番号付き(number)、テーブル形式(table)のリストを作成できる( type プロパティで指定)。
listheader には見出し行、item に各項目の説明を記述する。
listheader は最大で1つ、item は必要な個数記述できる。
プロジェクトファイルのプロパティを開き、「ビルド」>「出力」を選択する。
ドキュメントを出力する場合は「ドキュメント ファイル」にチェックを入れる。
